.TH lha_app_routes 1 "1 April 2010" "TrueCL Commands"

.SH NAME
lha_app_routines \- Manage IP route checking for Aplications

.SH SYNOPSES
.TS
l l.
lha_app_probes --list	\fB--application\fP \fIA\fP
	[\fB--force\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--timeout\fP \fIN\fP]

lha_app_probes --set	\fB--application\fP \fIA\fP \fB--label\fP \fIL\fP \fB--ipaddr\fP \fIN\fP
	\fB--maxwait\fP \fINN\fP
	[\fB--force\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--timeout\fP \fIN\fP]

lha_app_probes --delete	\fB--application\fP \fIA\fP \fB--label\fP \fIL\fP
	[\fB--force\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--timeout\fP \fIN\fP]
.TE

.SH DESCRIPTION
The \fIlha_app_routes(1)\fP command is used to view, edit or delete application
specific IP level route checking. 

Application-specific route checking is entirely optional but has benefits for
certain applications. For example an application can check IP addresses of particular
router for example.

There are no limits to the number of IP routes that can be checked, but please
note that only one single threaded process per running application is used, and so if
a timeout occurs on a ICMP ping check, then other IP routes checks for the application
will be delayed.

.SH ARGUMENTS
.TP 8
--application
The name of the application to perform the specified action on. Just one of the 
support actions must be specified (either \fB--set\fP, \fB--delete\fP or \fB--list\fP).
.TP
--list
This is used to list the currently configured application routes that are to be
checked the fhe specified application. The output is given in the following columns:

.TP 4
.B Label
A word or string to refer to this particular IP route check as.
.TP
.B IP Address
The IP address or hostname to ping.
.TP
.B IP Type
The type of IP functionality - should be "4" or "6".
.TP
.B Max Wait
The maximum number of seconds to wait for an ICMP ping of the routine in
question can take before timeout indicating the route has failed.
.TP
.B Max Fails
The maximum number of failures after which am action based on the Severity
of the IP check is undertaken.
.TP
.B Reset Time
The number of seconds after which the last failure has occured which will result
in the number of failures being reset to 0.
.TP
.B Severity
This is "warning" or "error". When set to "warning" an alert is logged if a routine
is considered dead, and if it fails then the application must consider fail-over
to try a different node to work on.
.TP
.B Comments
Free text comments the administrator can use to indicate the purpose of the
route check.
.RE

.TP 8
--delete
Indicates a specified route is to be deleted. If the application is currently
running then the routes are dynamically changed as necessary.
.TP
--label
The name of the label to perform the action on. This argument is required if 
the action is \fB--set\fP or \fB--delete\fP.
.TP
--ipaddr
The IP address, ore preferrable, the symbolic DNS name, of the IP address
that should be checked.
.TP
--iptype
This should be "4" or "6". Although IP version "6" is accepted no such checks
are currently supported.
.TP
--maxfails
The maximum number of times a ICMP-echo request must time-out in the reset 
interval for a route to be considered "dead".
.TP
--severity
Two severities are currently supported. If set to "warning" then loss of a route
is considered to be non-critical to the application. The software will log a warning
and generate an 'app.net_route' event on the node in question, but nothing else.
Othewise the severity of "error" will cause the application to be failed-over to 
another node where the routes are considered to be available.
.TP
--resettime
The number of seconds after the last failure after which failure count is reset to 0.
.TP
--comments
A free text string that can be used by the administrator.
.TP
--force
This argument allows a change to the application routes to take place even
if not all nodes are contactable. This is not recommended but is sometimes
deemed necessary.
.TP
--timeout
The amount of time to wait for a node to respond to a request to
indicate whether it is alive or not, or to return routing information.
.TP
--debug
Perform the actions and generate debug level output. This is not 
typically required and should only be done if problems in cluster 
management occur.
.TP
--verbose
Verbose mode generates a sensible amount of output to standard output to 
show the progress of the routine add/set or delete.
.TP
--quiet
This will only produce errors and warnings on the standard output device.
.TP
--silent
Only produce output if fatal errors occurs during application route 
management.
.TP
--lwidth
The width of the standard output. This will default to 80 if the width
of the standard output device cannot be determined. 

.SH EXIT CODES
If the action is question is sucessful a '0' will be returned. Any other
value indicates failure.

.SH AUTHOR
The TrueCL software was written by Simon Edwards, (C) 2006-2010, working
for Advantsys Computer Services Ltd - www.advantsys.co.uk.

.SH SEE ALSO
.BR lha_event(1),
.BR lha_netd(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP. For
more information, please see the following page: truecl.advantsys.co.uk.

